/**
* Copyright 2014 Social Robotics Lab, University of Freiburg
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
*    # Redistributions of source code must retain the above copyright
*       notice, this list of conditions and the following disclaimer.
*    # Redistributions in binary form must reproduce the above copyright
*       notice, this list of conditions and the following disclaimer in the
*       documentation and/or other materials provided with the distribution.
*    # Neither the name of the University of Freiburg nor the names of its
*       contributors may be used to endorse or promote products derived from
*       this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
* \author Billy Okal <okal@cs.uni-freiburg.de>
* \author Sven Wehner <mail@svenwehner.de>
*/

#ifndef _shoppingplanner_h_
#define _shoppingplanner_h_

#include <pedsim/ped_vector.h>
#include <pedsim_simulator/waypointplanner/waypointplanner.h>

// Forward Declarations
class Agent;
class AttractionArea;

class ShoppingPlanner : public WaypointPlanner {
  Q_OBJECT

  // Constructor and Destructor
 public:
  ShoppingPlanner();

  // Signals
 signals:
  void lostAttraction();

 public slots:
  void loseAttraction();

  // Methods
 public:
  bool setAgent(Agent* agentIn);

  // → Waypoints
  AttractionArea* getAttraction() const;
  bool setAttraction(AttractionArea* attractionIn);

 protected:
  // → Helper Methods
  QString createWaypointName() const;
  Ped::Tvector getRandomAttractionPosition() const;
  Ped::Tvector createRandomOffset() const;

  // → WaypointPlanner Overrides
 public:
  static Type getPlannerType() { return WaypointPlanner::Individual; };
  virtual Waypoint* getCurrentWaypoint();
  virtual Waypoint* getNextWaypoint();
  virtual bool hasCompletedWaypoint();
  virtual bool hasCompletedDestination() const;

  virtual QString name() const;

  // Attributes
 protected:
  Agent* agent;
  AttractionArea* attraction;
  // → Waypoints
  Waypoint* currentWaypoint;
  double timeReached;
};

#endif
